/* Copyright 2007-2008 dnAnalytics Project.
 *
 * Contributors to this file:
 * Patrick van der Velde
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright notice, this 
 *   list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice, 
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * * Neither the name of the dnAnalytics Project nor the names of its contributors
 *   may be used to endorse or promote products derived from this software without
 *   specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using dnAnalytics.LinearAlgebra;
using System.ComponentModel;
using System.Diagnostics;

namespace dnAnalytics.DebugVisualizers
{
    /// <summary>
    /// Defines the base interface for classes that store matrix properties
    /// for use in a <c>PropertyGrid</c>.
    /// </summary>
    public abstract class MatrixProperties
    {
        /// <summary>
        /// Returns the matrix.
        /// </summary>
        [Browsable(false)]
        protected abstract Matrix Matrix
        {
            get;
        }

        /// <summary>
        /// Returns the name of the matrix.
        /// </summary>
        [Category("General information")]
        [DisplayName("Name")]
        [Description("The type of matrix being displayed.")]
        public string Name
        {
            [DebuggerStepThrough]
            get
            {
                return Matrix.GetType().Name;
            }
        }

        /// <summary>
        /// Returns the number of columns in the matrix.
        /// </summary>
        [Category("Dimensions")]
        [DisplayName("Number of columns")]
        [Description("The number of columns in the matrix.")]
        public int Columns
        {
            [DebuggerStepThrough]
            get
            {
                return Matrix.Columns;
            }
        }

        /// <summary>
        /// Returns the number of rows in the matrix.
        /// </summary>
        [Category("Dimensions")]
        [DisplayName("Number of rows")]
        [Description("The number of rows in the matrix.")]
        public int Rows
        {
            [DebuggerStepThrough]
            get
            {
                return Matrix.Rows;
            }
        }

        /// <summary>
        /// Returns the total number of elements in the matrix.
        /// </summary>
        [Category("Dimensions")]
        [DisplayName("Total number of elements")]
        [Description("The number of elements in the matrix.")]
        public int Total
        {
            [DebuggerStepThrough]
            get
            {
                return Matrix.Rows * Matrix.Columns;
            }
        }

        /// <summary>
        /// Returns the value at the specified row and column index.
        /// </summary>
        /// <param name="row">The row index.</param>
        /// <param name="column">The column index.</param>
        /// <returns>The requested value.</returns>
        public double Item(int row, int column)
        {
            return Matrix[row, column];
        }
    }
}